GetGUID {Link Object}

GetGUID

Syntax

SapObject.SapModel.LinkObj.GetGUID

VB6 Procedure

Function GetGUID(ByVal name As String, ByRef GUID As String) As Long

Parameters

Name

The name of an existing link object.

GUID

The GUID (Global Unique ID) for the specified link object.

Remarks

This function retrieves the GUID for the specified link object.

This function returns zero if the link object GUID is successfully retrieved; otherwise it returns nonzero.

VBA Example

Sub GetLinkObjGUID()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Name As String

Dim GUID As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add link object by points

ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

'set program created GUID

ret = SapObject.SapModel.LinkObj.SetGUID("1")

'get GUID

ret = SapObject.SapModel.LinkObj.GetGUID("1", GUID)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 12.00.

See Also

SetGUID